Added figures to generated documentation #767
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also, added prefLabel as anchoring points such that one can use the browser
to easily get documentation of a concept one knows the prefLabel of.
For example, entering
https://w3id.org/emmo#Atom
should bring you to the section in the html doc that documents Atom.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #767 +/- ##
==========================================
+ Coverage 72.63% 72.72% +0.08%
==========================================
Files 18 18
Lines 3706 3721 +15
==========================================
+ Hits 2692 2706 +14
- Misses 1014 1015 +1 ☔ View full report in Codecov by Sentry. |
francescalb
requested changes
Jun 3, 2024
…mmo-repo/EMMO-python into add-figures-to-generated-documentation
It is tested, both online and in the tests/ folder |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added figures to generated documentation. If the value of a property matches a regex for a figure on the web, it will be included in the documentation.
Further work: The figure size should probably be adjusted to not make the table too large. Probably preferred to only show a thumbnail-sized version of the figure in the table. The full size could be shown by clicking. Easier to play with in a following-up PR when this is applied to EMMO.
Also, added prefLabel as anchoring points such that one can use the browser to easily get documentation of a concept one knows the prefLabel of.
For example, entering
should bring you to the section in the html doc that documents Atom.
Description
Type of change
Checklist
This checklist can be used as a help for the reviewer.
Comments